Die Ultimative Software-P…i Collection 1996 & 1997/Die Ultimative Software-Pakete CD-ROM fur Atari Collection 1996 & 1997.iso/p/portfoli/ws_edit/edit.doc

Text File | 1996-10-30 | 20.4 KB | 366 lines

                    HOW TO USE THIS EDITOR

 Before you can RUN this editor on the Portfolio, you have to change the
 'External Display mode' in 'Tracked'. Run APP/S to change this setting.

 GETTING STARTED: From the operating system type EDIT [D:][Path]FILE.EXT<CR>
 where FILE is the name of the file you wish to edit (up to eight characters)
 and EXT is the extension. If no file name is given on the command line, the
 program will query you for a file name. The drive designation, D:, and path
 designation are optional; if they are omitted, the program will search the
 currently logged drive and directory. The file name including path
 specification can have up to 24 characters.

 If a file is found with the name you have given, the program will load it,
 and present a screen for editing. If no file with this name is found, the
 program will ask you if this is a new file. If you really intend to create
 a new file, press "Y", and the program will present you with a blank screen
 ready to enter text. On the other hand, you may have misspelled the name of
 the file or made some other mistake that prevented the program from finding
 your file; if so, press "N" and the program will dump you back into the
 operating system so that you can try again.

 The maximum file size that can be loaded depends on the amount of free
 memory you have in your machine. EDIT allocates space for 160 characters to
 each line of text; if your text has a lot of white space and blank lines,
 it will be loaded inefficiently. As a rule of thumb, you will need memory
 equal to 3 times the length of the file; thus, to edit a 100K file you will
 need 300K of free memory. The maximum number of lines that can be edited is
 2730. If you try to load a file that is too long for the available memory,
 the program will write "insufficient memory" and dump you back into the
 operating system. If you try to edit a file whose lines are longer than 160
 characters, the program will write "file too fat for this editor" and dump
 you back to the operating system. This is usually what happens when you try
 to edit a non ASCII file.

 DISPLAY. The statusline at the top of the screen shows the following: the
 line and the column numbers, updated after every keystroke, the editing
 mode which is either "insert" or "overwrite", the word wrap status, either
 "wordwrap" or "nowrap", and the name of the file you are editing. Finally
 there is a space on the extreme right which can contain an asterisk. The
 asterisk will appear as soon as you have changed something in the file.

 The second line of the screen is the ruler line, which shows the width of
 the text. If the editor is in the "wordwrap" mode, this line shows left and
 right margins indicated by markers. When text is entered in the wordwrap
 mode it will be aligned between these two markers. This program turns on with
 the left margin set at column 1 and the right margin at column 76.

 Some explanations: in the "insert" mode, any letter typed is inserted into
 the line at the cursor position and the rest of the line is pushed to the
 right. In the "overwrite" mode, any letter typed replaces the letter over
 the cursor and the rest of the line is unchanged. In "wordwrap" mode the
 program automatically moves any word that extends past the right margin to
 the beginning of the next line - sort of an automatic carriage return. In
 the "nowrap" mode, you have to insert the carriage returns yourself.
 Initially, the program comes on in the "insert" and "wordwrap" modes.

 The rest of the screen is a window that displays 23 lines of text. A
 maximum of 79 characters are displayed on each line. A "<" symbol appears
 the 80th column if all the characters up to the end of a line can be
 displayed, If there are more than 79 characters in the line so that some
 characters on the right do not appear on the screen, a "+" symbol appears
 in the 80th column. If there is no symbol in the 80th column, the line is
 empty. With wide files (lines longer than 80 characters), the text may be
 shifted so that the beginning of the lines do not show on the screen. The
 ruler line shows you what part of the text you are looking at.

 CHANGING THE STATUS: To toggle between "insert" and "overwrite" press the
 "Ins" key. Note the change in the status line as this key is pressed. To
 change other status parameters, type ^O ("Cntl" and "O" simultaneously) for
 "Onscreen". You will be asked "wordwrap?". Press either "Y" or "N".
 Pressing "N" turns off the margin markers and sets the left margin to 1. If
 you press "Y" you will queried for the left and right margins. The left
 margin may not exceed 80 and the right margin must be at least 24 spaces
 bigger than the left margin. Pressing <CR> at a query will leave these
 margins at their current settings.

 TYPING: When entering text, the normal position of the cursor is one
 space past the end of the current line. A carriage return, <CR>, will
 create a new line and move the cursor to the beginning of this line; a <CR>
 with the cursor in the middle of a line of text will create a new line and
 move all the text to the right of the cursor to the new line. A backarrow
 (delete) with the cursor in the first column will delete the current line
 and stack all text to the right of the cursor on top of the previous line.
 A ^N (hold down the "N" key and the control key at the same time) will
 create a new blank line above the current line.

 MOVING THE WINDOW: The screen can be thought of as a window viewing a
 portion of the text. To push the window down by one line push ^Z (press
 control and "z" at the same time). To push it up by one line press ^W. To
 push the viewing window down 22 lines in the text, press the "Pg Dn" key.
 To push it up by 22 lines, press the "Pg Up" key. To move the cursor all
 the way to to the bottom of the file, press the control and "Pg Dn" key at
 the same time. Control and "Pg Up" moves the cursor to the top of the file.

 TRAVELING: To move the cursor, use the cursor arrow keys. If you try to move
 the cursor off the screen, the window will shift up, down or sideways so
 that the cursor remains visible.

 The left and right arrow keys will not move the cursor off the current
 line. If the right arrow key takes the cursor past the end of the current
 line, entering any character will fill in the intervening space with
 blanks. Holding down the left arrow key moves the cursor to the beginning
 of the current line where it stops. The up and down keys will not take the
 cursor into a region where there is no text.

 The "Home" key moves the cursor to the left margin on the current line. The
 "End" key moves the cursor to the end of the current line. In the wordwrap
 mode, lines ordinarily have a blank space at the end so that pressing "End"
 positions the cursor properly to add more words to the line.

 To move the cursor left by one word, press function key F3; to move right
 one word, press F4. F3 stops in the space between words; this is the
 correct position for inserting punctuation. F4 stops at the beginning of
 the next word; this is the correct position for inserting words or cutting
 the line to start a new line. Keys F3 and F4 go "around the corner" whereas
 the cursor arrow keys do not; if F4 is pressed while the cursor is under
 the last word in the current line, the cursor will move to the first word
 in the next line. If F3 is pressed while the cursor is under the first word
 of the current line, the cursor will move to the end of the last word in
 the previous line.

 TABS There are no fixed tabs. When you wish to enter data in columns, write
 the first line with appropriate spaces and use the tab key to align
 subsequent entries on the top line. The "Tab" key moves the cursor to the
 right until it lines up with the beginning of the next word on the previous
 line; if this moves the cursor past the end of the current line, blank
 spaces are inserted to fill in the line up to the cursor. The tab key is
 useful when writing code in structured languages such as Pascal or C.

 DELETIONS: To delete the character currently over the cursor, push the
 "Del" key. To delete one character to the left of the cursor, push the
 backarrow key, "<--". This key moves the cursor to the left one space.

 To delete a word to the left of the cursor, press F1. To delete a word to
 the right of the cursor, press F2. Like F3 and F4, keys F1 and F2 go
 "around the corner" to the next or previous line.

 To delete an entire line, press F5. To delete all text from the cursor to
 the end of the line, press F6. To delete an entire paragraph, position the
 cursor on the first line of the paragraph and push F5 repeatedly until the
 paragraph is deleted. F5 normally moves the cursor down one line except
 when the cursor is on the last line in the text; then it moves the cursor
 up one line.

 UNDELETION: If you delete some text by mistake, the "Esc" key will undo any
 deletions produced by the F1, F2, F5, and F6 keys provided no new
 characters have been typed in the mean time.

 This undo feature can be used as a cut & paste facility to move phrases or
 paragraphs.

 To move a phrase to another part of a sentence, delete the phrase using F1
 F2 and F6, move the cursor to the place in the sentence where you want the
 phrase to reappear and press "Esc". Then prss F7 to reorder the paragraph
 (see below) The order of the words will be preserved irrespective of the
 order in which you pressed F1 and F2. A maximum of 255 characters can be
 moved with F1, F2 and F6.

 To move a paragraph, delete the lines in the paragraph using F5, move the
 cursor to the place in the file where you wish to relocate the paragraph,
 and press "Esc". The lines will be inserted just above the current position
 of the cursor. A maximum of 30 lines can be moved; if your text is longer
 than 30 lines, you will have to use two or more cycles to move it. Pressing
 "Esc" clears the buffer where the deletions are stored.

 If you wish to replicate some text, delete the text and press ^U for
 "Undo". This will restore the text in the original location but will not
 clear the buffer. Now go to the new location and press "Esc" to put a
 duplicate copy of the text in the new location.

 You can move words or you can move text lines with the delete/undelete
 sequence. You cannot move both in the same cycle. You will restore
 whichever you deleted last.

 PARAGRAPH REFORMAT: Insertions and deletions will usually result in lines
 of unequal lengths. To neaten up the appearance of the paragraph, press F7.
 The lines in the paragraph - a paragraph is a block of text delineated by
 blank lines - will be adjusted to more or less equal length with right and
 left margins corresponding to the marks in the ruler line. This program
 does not do hyphenation. For the neatest possible right margin, you will
 have to insert hyphens by hand.

 To split a long paragraph into two short paragraphs, position the cursor at
 the beginning of the sentence where you want the split, press <CR> twice
 and then F7.

 If the margin marks are not visible, key F7 will not do anything; reformat
 works only when the program is in the "wordwrap" mode.

 The paragraph reformat routine can only handle 30 lines at a time. If your
 paragraph has more than 30 lines, you will have to repeat the F7 command
 until the paragraph is completely reformatted.

 Reformat does not preserve indentations; if you wish to indent a paragraph,
 reformat it starting with the cursor on the second line of the paragraph.

 CASE CHANGE: Pressing F8 will change the case of the letter over the cursor
 and move the cursor to the first letter of the next word. Control F8 will
 change the case of all of the letters in a word and move the cursor to the
 next word. If a word is already capitalized, F8 will uncaptitalize it. If a
 word is written in block capitals, ^F8 will change the letters to lower
 case.

 INSERT AS ASCII CODE: Some characters, such as graphics symbols and Greek
 letters cannot be typed from the keyboard; other characters with a decimal
 order less than 32 will be interpreted as commands if typed. Any character,
 from 0 to 255 can be inserted into the text by the sequence <alt>A nnn <CR>
 where nnn is the ASCII number (decimal) of the character.

 This feature may be used to write printer codes at the beginning of a file
 so as to select the type font and the line spacing that you want the
 printer to use when you copy your file to the printer. Be sure to insert a
 printer code at the end of the file to restore the printer to its original
 settings.

 Another application of this feature is to print individual words or phrases
 in underlined, boldface or italic type font. Consult your printer manual
 for the proper sequences to change into and out of these modes.

 To make the printer start a new page, type ASCII code 12.

 FIND & REPLACE: To find a word or phrase and replace it with something
 else, press F9. The statusline will disappear; in its place you will be
 asked "find?" for the text to find (up to 24 characters) and "replace
 with?" for the text to replace it. The find text is case sensitive, i.e.
 "Aardvark" is not the same as "aardvark".

 The program will search forward from the present location of the cursor; if
 the text is found it will be displayed in a gaudy color scheme, and you
 will be asked if you really want to make the replacement. Press either "Y"
 or "N". Key F10 repeats the find or find & replace operation. If the text
 is not found, the program will give a warning beep and position your cursor
 at the end of the file.

 If you just want to find text, enter a null string, <CR>, to the question
 "Replace with?' With a null string in the replacement buffer, the program
 just moves the cursor with no query about replacement.

 The program turns on with "." in the find buffer and a null string in the
 replacement buffer; thus, until something else is entered in the find
 buffer, F10 will move the cursor to the end of the current sentence.

 LOAD: To load text from another file and insert it into the file you are
 editing, move the cursor to the line where you wish to insert the text and
 press ^L. The program will query you for the name of the file you wish to
 load. If the file is found, text from the file will be inserted starting
 just below the line where your cursor is currently located. Cursor position
 will be unchanged by the load.

 PUT: To put a portion of your text on a disk as a separate file, move the
 cursor to the first line of the text you wish to output and press ^P. The
 program will query you for the name of the file you wish to create.
 If a file with this name already exists, the program will append your output
 text to the existing file. Entering <CR> selects the default name. The
 default name is the file you are editing with the extension .XRP; thus, if
 you are editing 'MYFILE.TXT', your excerpt will be written to the disk as
 'MYFILE.XRP'.

 Use the up and down arrow keys to move the cursor to the end of the
 text that you wish to output. On color screens the text to be output will
 be highlighted in green. Only entire lines may be output; there is no limit
 to the number of lines. Press <CR> to write the text to the output file.

 Recapitulation of Function Keys: To see this information on your screen,
 type <alt> H which brings up a help screen.

      F1    : Delete word to the left
      F2    : Delete word to the right
      F3    : Move cursor one word to the left
      F4    : Move cursor one word to the right
      F5    : Delete line and store in buffer
      F6    : Delete from cursor to the end of the line
      F7    : Reformat paragraph
      F8    : Capitalize word     (^F8 : block capitals)
      F9    : Find & Replace
      F10   : Repeat Find & Replace
      <Esc> : Undo deletions and clear buffer
      ^U    : Undo deletions and retain buffer
      ^P    : Put excerpt to disk
      ^L    : Load insert from disk
      ^O    : Wordwrap on/off. Reformat screen
      ^K    : Quit the editor

 EDIT recognizes as alternates most one-keystroke Wordstar(TM) commands.
 ^Q as in ^Q^F or ^Q^A calls the find & replace procedure; ^K as in ^K^D or
 ^K^X quits the editor.

 QUITTING: To quit the editor, type ^K (press control and "k" at the same
 time). If you have only been reading the file and the file has not been
 changed, the program exits to the system immediately. If the file has been
 changed, the program will ask you if you wish to save your changes. If you
 answer "Y" the program writes "as: ". Here, you have two choices. Enter
 <CR> and you will overwrite the old file on the disk. If you wish to save
 the old file as a backup, you must think up a new name for your altered
 file. Entering this new name will cause your altered text to be written as
 a new file, leaving your old file on the disk unchanged.

 This program does not make a backup copy of the file that you are editing
 when starting, but since it works with the contents of the file entirely in
 machine memory and the source file closed, your original file will not be
 lost if the the power fails, or you hang up the machine and have to reboot
 while editing. However, when writing long files it is good practice to quit
 and reload from time to time so as to save your changes.

Final notes:

 COLOR CHANGE Users who are dissatisfied with the present color scheme may
 experiment by typing <alt> C to change the text color and <alt> B to change
 the background. There are 16 possible text colors and 8 possible background
 colors, giving 128 possible color combinations - 8 of them, of course,
 totally invisible e.g. blue on blue. When you have found an agreeable color
 combination, you can insert the values you have chosen in GetVideoMode by
 changing the assignments of attributes 'normal' and 'gaudy'. An attribute is
 16 times the background color + the text color. For example, this text is
 grey (color = 7) on a background of blue (color = 1); therefore the
 attribute 'normal' is 16*1 + 7 or 23.

 The first line of the screen, the status line, uses a rather gaudy color
 scheme in order to provide a cue as to when you are in the edit mode; the
 gaudy colors disappear when you are answering questions and reappear when
 you get back into the edit mode. If you prefer more subdued colors, type ^D
 to make the status line use the same colors as the rest of the screen.

 SPELLING This program can be used in conjunction with the Borland Turbo
 Lightning spelling checker program, since it has no keystrokes in common
 with that program.



         ----------------end-of-author's-documentation---------------

                        Software Library Information:

                   This disk copy provided as a service of

                        The Public (Software) Library

         We are not the authors of this program, nor are we associated
         with the author in any way other than as a distributor of the
         program in accordance with the author's terms of distribution.

         Please direct shareware payments and specific questions about
         this program to the author of the program, whose name appears
         elsewhere in  this documentation. If you have trouble getting
         in touch with the author,  we will do whatever we can to help
         you with your questions. All programs have been tested and do
         run.  To report problems,  please use the form that is in the
         file PROBLEM.DOC on many of our disks or in other written for-
         mat with screen printouts, if possible.  The P(s)L cannot de-
         bug programs over the telephone.

         Disks in the P(s)L are updated monthly, so if you did not get
         this disk  directly from the P(s)L,  you should be aware that
         the files in this set may no  longer be the current versions.

         For a copy of the latest monthly software library newsletter
         and a list of the 1,000+ disks in the library, call or write

                        The Public (Software) Library
                              P.O.Box 35705 - F
                           Houston, TX 77235-5705
                      [phone] or [phone]